Reinstate supplemental remarks (System.Globalization, System.IO)#12705
Merged
Conversation
Contributor
|
Tagging subscribers to this area: @dotnet/area-system-globalization |
tarekgh
reviewed
Jun 4, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR reintegrates previously external “Supplemental API remarks” content back into the ECMA XML reference files for several System.IO and System.Globalization APIs, and adds/updates snippet projects to support the expanded remarks (including new C# and Visual Basic snippet assets).
Changes:
- Replaced “Supplemental API remarks” links with inlined markdown remarks across targeted XML reference files.
- Added/updated snippet projects and snippet source files (C# + Visual Basic) to back the new remarks content.
- Removed an obsolete ASP.NET-related snippet and updated snippet targeting to modern TFMs.
Reviewed changes
Copilot reviewed 53 out of 53 changed files in this pull request and generated 12 comments.
Show a summary per file
| File | Description |
|---|---|
| xml/System.IO/FileSystemWatcher.xml | Inlines supplemental remarks content into the type’s <remarks> section. |
| xml/System.IO/FileStream.xml | Inlines supplemental remarks content into the type’s <remarks> section. |
| xml/System.Globalization/SortVersion.xml | Replaces external supplemental-remarks link with inlined remarks content. |
| xml/System.Globalization/SortKey.xml | Replaces external supplemental-remarks link with inlined remarks content. |
| xml/System.Globalization/RegionInfo.xml | Replaces external supplemental-remarks link with inlined remarks content and adds snippet references. |
| xml/System.Globalization/PersianCalendar.xml | Replaces external supplemental-remarks link with inlined remarks content. |
| xml/System.Globalization/NumberFormatInfo.xml | Replaces external supplemental-remarks link with large inlined remarks content and snippet references. |
| xml/System.Globalization/DateTimeFormatInfo.xml | Replaces external supplemental-remarks link with large inlined remarks content and snippet references. |
| xml/System.Globalization/CultureInfo.xml | Replaces external supplemental-remarks links with extensive inlined remarks content and many snippet references. |
| xml/System.Globalization/CompareOptions.xml | Replaces external supplemental-remarks link with inlined remarks content. |
| xml/System.Globalization/CompareInfo.xml | Replaces external supplemental-remarks link with inlined remarks content. |
| snippets/visualbasic/System.Globalization/CultureInfo/InvariantCulture/Project.vbproj | Adds a VB snippet project for CultureInfo.InvariantCulture content. |
| snippets/visualbasic/System.Globalization/CultureInfo/InvariantCulture/persist1.vb | Adds a VB snippet used by InvariantCulture remarks. |
| snippets/visualbasic/System.Globalization/CultureInfo/CurrentUICulture/Project.vbproj | Adds a VB snippet project for CultureInfo.CurrentUICulture content. |
| snippets/visualbasic/System.Globalization/CultureInfo/CurrentUICulture/Get1.vb | Adds a VB snippet for getting CurrentUICulture. |
| snippets/visualbasic/System.Globalization/CultureInfo/CurrentUICulture/currentuiculture1.vb | Adds a VB snippet for setting CurrentUICulture. |
| snippets/visualbasic/System.Globalization/CultureInfo/CurrentUICulture/Async1.vb | Adds a VB async/task snippet for CurrentUICulture. |
| snippets/visualbasic/System.Globalization/CultureInfo/CurrentCulture/specific12.vb | Adds a VB snippet comparing specific vs neutral culture behavior. |
| snippets/visualbasic/System.Globalization/CultureInfo/CurrentCulture/Project.vbproj | Adds a VB snippet project for CultureInfo.CurrentCulture content. |
| snippets/visualbasic/System.Globalization/CultureInfo/CurrentCulture/Program.vb | Adds a VB entrypoint that invokes snippet code. |
| snippets/visualbasic/System.Globalization/CultureInfo/CurrentCulture/Get1.vb | Adds a VB snippet for getting CurrentCulture. |
| snippets/visualbasic/System.Globalization/CultureInfo/CurrentCulture/Async1.vb | Adds a VB async/task snippet for CurrentCulture. |
| snippets/csharp/System.Globalization/DateTimeFormatInfo/serialize2.cs | Adds a C# snippet used by DateTimeFormatInfo serialization remarks. |
| snippets/csharp/System.Globalization/DateTimeFormatInfo/serialize1.cs | Adds a C# snippet used by DateTimeFormatInfo serialization remarks. |
| snippets/csharp/System.Globalization/DateTimeFormatInfo/project.csproj | Adds a C# snippet project for DateTimeFormatInfo content. |
| snippets/csharp/System.Globalization/DateTimeFormatInfo/parse2.cs | Adds a C# snippet used by DateTimeFormatInfo parsing remarks. |
| snippets/csharp/System.Globalization/DateTimeFormatInfo/parse1.cs | Adds a C# snippet used by DateTimeFormatInfo parsing remarks. |
| snippets/csharp/System.Globalization/DateTimeFormatInfo/instantiate6.cs | Adds a C# snippet used by DateTimeFormatInfo instantiation remarks. |
| snippets/csharp/System.Globalization/DateTimeFormatInfo/instantiate3.cs | Adds a C# snippet used by DateTimeFormatInfo instantiation remarks. |
| snippets/csharp/System.Globalization/DateTimeFormatInfo/instantiate2.cs | Adds a C# snippet used by DateTimeFormatInfo instantiation remarks. |
| snippets/csharp/System.Globalization/DateTimeFormatInfo/formatprovider1.cs | Adds a C# snippet illustrating IFormatProvider behavior. |
| snippets/csharp/System.Globalization/DateTimeFormatInfo/example5.cs | Adds a C# snippet used by DateTimeFormatInfo examples. |
| snippets/csharp/System.Globalization/DateTimeFormatInfo/example4.cs | Adds a C# snippet used by DateTimeFormatInfo examples. |
| snippets/csharp/System.Globalization/DateTimeFormatInfo/example3.cs | Adds a C# snippet used by DateTimeFormatInfo examples. |
| snippets/csharp/System.Globalization/DateTimeFormatInfo/example2.cs | Adds a C# snippet used by DateTimeFormatInfo examples. |
| snippets/csharp/System.Globalization/DateTimeFormatInfo/example1.cs | Adds a C# snippet used by DateTimeFormatInfo examples. |
| snippets/csharp/System.Globalization/DateTimeFormatInfo/create2.cs | Adds a C# snippet used by DateTimeFormatInfo creation remarks. |
| snippets/csharp/System.Globalization/DateTimeFormatInfo/create1.cs | Adds a C# snippet used by DateTimeFormatInfo creation remarks. |
| snippets/csharp/System.Globalization/CultureInfo/InvariantCulture/persist1.cs | Adds a C# snippet used by CultureInfo.InvariantCulture remarks. |
| snippets/csharp/System.Globalization/CultureInfo/CurrentUICulture/Project.csproj | Adds a C# snippet project for CurrentUICulture. |
| snippets/csharp/System.Globalization/CultureInfo/CurrentUICulture/Get1.cs | Adds a C# snippet for getting CurrentUICulture. |
| snippets/csharp/System.Globalization/CultureInfo/CurrentUICulture/currentuiculture1.cs | Adds a C# snippet for setting CurrentUICulture. |
| snippets/csharp/System.Globalization/CultureInfo/CurrentUICulture/Async1.cs | Adds a C# async/task snippet for CurrentUICulture. |
| snippets/csharp/System.Globalization/CultureInfo/CurrentCulture/specific12.cs | Adds a C# snippet comparing specific vs neutral culture behavior. |
| snippets/csharp/System.Globalization/CultureInfo/CurrentCulture/specific1.cs | Minor formatting update to an existing CurrentCulture snippet. |
| snippets/csharp/System.Globalization/CultureInfo/CurrentCulture/Project.csproj | Adds/updates a C# snippet project for CurrentCulture. |
| snippets/csharp/System.Globalization/CultureInfo/CurrentCulture/Program.cs | Adds a C# driver/entry file for snippet compilation. |
| snippets/csharp/System.Globalization/CultureInfo/CurrentCulture/Get1.cs | Adds a C# snippet for getting CurrentCulture. |
| snippets/csharp/System.Globalization/CultureInfo/CurrentCulture/currentculture.csproj | Retargets an existing snippet project to net10.0. |
| snippets/csharp/System.Globalization/CultureInfo/CurrentCulture/currentculture.cs | Minor formatting update in an existing snippet source file. |
| snippets/csharp/System.Globalization/CultureInfo/CurrentCulture/changeculture11.cs | Adds a C# snippet demonstrating changing culture on a thread. |
| snippets/csharp/System.Globalization/CultureInfo/CurrentCulture/Async1.cs | Adds a C# async/task snippet for CurrentCulture. |
| snippets/csharp/System.Globalization/CultureInfo/CurrentCulture/aspculture1.cs | Removes an obsolete ASP.NET-oriented snippet. |
BillWagner
approved these changes
Jun 5, 2026
Member
BillWagner
left a comment
BillWagner
left a comment
There was a problem hiding this comment.
This LGTM. I didn't see anything major. Let's keep moving forward.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Contributes to #12613.
Also removes .NET Framework remarks.